<!--$Id: db_join.so,v 11.22 2002/08/18 21:17:26 bostic Exp $-->
<!--$Id: m4.tcl,v 11.28 2004/12/16 19:13:05 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: db join</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b><i>db</i> <b>join</b></b>
</td>
<td align=right>
<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>db join
	<i>db.cX</i>
	<i>db.cY</i>
	<i>db.cZ</i>
	...
</pre></b>
<b>Description(db join)</b>
<p>The <i>db</i> <b>join</b> command joins the specified cursors and returns a
cursor handle that can be used to iterate through the joined {key data}
pairs.  The returned cursor handle is bound to a Tcl command of the form
<b>dbN.cX</b>, where X is an integer starting at 0 (for example,
db0.c0 and db0.c1).  It is through this Tcl command that the script
accesses the cursor methods.</p>
<p>The returned join cursor has limited cursor functionality, and only the
<i>dbc</i> <b>get</b> and <i>dbc</i> <b>close</b> commands will succeed.</p>
<p>See <a href="../ref/am/join.html">Equality join</a> for more information on
the underlying requirements for joining.</p>
<p>In a transaction-protected environment, all the cursors listed must have
been created within the same transaction.</p>
<p>In the case of error, a Tcl error is thrown.</p>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>
